home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / program / seemodul.lha / SeeModule / SeeModule.doc < prev    next >
Text File  |  1995-08-13  |  6KB  |  155 lines
  1.                                     
  2.                              SeeModule V2.1               (August 13, 1995)
  3.                              --------------
  4.     General:
  5.     -------
  6.     This program is an offshoot of "Mods2Guide" V2.  It is based on a
  7.     suggestion made to me by Barry Wills.
  8.  
  9.     Mods2Guide creates an AmigaGuide database containing the expanded
  10.     ASCII contents of the Amiga E Modules directory, for easy reference,
  11.     plus an alphabetical index of all of the module names, for those who
  12.     prefer that style of reference.  The size of these two files, for the
  13.     standard Modules directory that comes with the Amiga E V3.2a
  14.     distribution package, is almost 400K.  As more modules are created,
  15.     I expect this size will only increase.
  16.  
  17.     SeeModule takes a different approach - you can think of it as a GUI
  18.     for "ShowModule".  This program also creates an AmigaGuide database
  19.     (called "SeeModule.guide") which contains the names of all of the
  20.     Amiga E modules.  Visually, it is almost identical to Mods2Guide.
  21.     The difference is that the modules have NOT been pre-expanded.
  22.  
  23.  
  24.     Requirements:
  25.     ------------
  26.     *  "Emodules:" must be assigned to the directory containing the modules.
  27.     *  Kickstart 37 (Workbench 2.04) or later.
  28.  
  29.  
  30.     Limitations:
  31.     -----------
  32.     The program will exit gracefully if:
  33.     *  There are directories nested inside of directories.
  34.     *  There are more than 98 directories.
  35.     *  There are more than 75 files in any directory (except the
  36.          root directory).
  37.  
  38.     If for any reason Wouter should change the output format of his
  39.     ShowModule program, this version of SeeModule will probably no longer
  40.     function properly.
  41.  
  42.  
  43.     Usage:
  44.     -----
  45.     So how do I use this thing, you ask?
  46.  
  47.     1.  Run the SeeModule program.  Options are itemized below.
  48.         The file "SeeModule.guide" will be created in RAM:
  49.  
  50.     2.  Load SeeModule.guide into AmigaGuide.  Find the module you want
  51.         to examine.
  52.  
  53.     3.  Click on the name of the module.  There will be little or no
  54.         indication that anything has happened (perhaps a flicker of
  55.         disk activity), but the module will be expanded to a user-
  56.         definable file.
  57.  
  58.     4.  Run your favorite text reader, and examine the module.
  59.  
  60.     The program may be run from a Shell or Workbench.
  61.     Just double-click the icon, but then you are stuck with the defaults -
  62.     (Hey, I'm just learning!), or in a Shell enter "SeeModule".
  63.     "SeeModule INFO" gives a brief description of the command template.
  64.     Command line arguments are optional - all options have defaults.
  65.  
  66.     <Control - C> will halt the program at any time.
  67.  
  68.  
  69.     Command Line Template:
  70.     ---------------------
  71.     The command line template of SeeModule V2.1 is as follows:
  72.  
  73.              INFO/S, I=INDEX/S, R=REPLACE/S, S=SMDIR/K,
  74.              D=DEST/S, H=HEIGHT/N, ND/N, NF/N, NR/N
  75.  
  76.  
  77.     Argument Description:
  78.     --------------------
  79.       INFO     Displays some basic information.
  80.       INDEX    Show module names alphabetically.  Default is by directory.
  81.       REPLACE  Replace the module in the dest. file with the new module.
  82.                Default is to append the new module.  Without REPLACE, the
  83.                destination file will grow larger, as new modules are added.
  84.       SMDIR    The path to the directory containing ShowModule.  The default
  85.                is that ShowModule is already in your search path.  If used,
  86.                the path must end in a ":" or a "/".
  87.       DEST     Name of the destination file to contain the expanded modules.
  88.                Default is "RAM:CurrentModules.txt".
  89.                EG.  SeeModule DEST=RAD:MyModules
  90.       HEIGHT   The height (in rows) of the AmigaGuide file.
  91.                The default is 16, which nicely fills a 200 pixel high window.
  92.                A height of 5 will be used if a number < 5 is entered.
  93.  
  94.     If the "INDEX" argument is used, the modules are always listed one to a
  95.     line.  Otherwise, the following three arguments can also be used:
  96.  
  97.       ND       Number of directory names placed on 1 line.  These are the
  98.                names in the main (Contents) window.  The default is 4.
  99.       NF       Number of filenames placed on 1 line.  These are the filenames
  100.                shown when you click on a directory name.  The default is 2.
  101.       NR       Number of root-filenames placed on 1 line.  The default is 3.
  102.  
  103.  
  104.     Example:
  105.     -------
  106.     1> Run SeeModule REPLACE  SMDIR=DH0:AmigaE/Bin/  NR=2   
  107.  
  108.  
  109.     Advantages/Disadvantages:
  110.     ------------------------
  111.     The advantages of SeeModule over Mods2Guide are:
  112.     
  113.     1.  You do not have to keep files occupying 400K+ on your harddrive.
  114.         The current size of "SeeModule.guide" (for V3.2a) is <30K.
  115.     
  116.     2.  The AmigaGuide database will be created with very little free RAM
  117.         required.  Mods2Guide V2.1 requires about 900K of free RAM to
  118.         expand the V3.2a standard modules.
  119.  
  120.     The primary disadvantage is that it is not as convenient, due to the
  121.     two-step approach (expand with SeeModule.guide, read with your text
  122.     reader).  This disadvantage can be minimized by using the macro feature
  123.     available with most text editors.  In my case, I made a small ARexx
  124.     macro, something like:
  125.  
  126.              /*  SeeModule.edge  */
  127.  
  128.            ADDRESS COMMAND
  129.            'AmigaGuide RAD:SeeModule.guide'
  130.            'TextReader RAM:CurrentModules.txt'
  131.  
  132.     Change the names of the files and paths to suit your own situation.
  133.  
  134.     This macro may now be bound to a keyboard combination, for example,
  135.     <Alternate - S> (for SeeModule), or <Alternate - M> (for Modules).
  136.     Pressing this combination will now load the "SeeModule.guide" database
  137.     into AmigaGuide.  Click on the module(s) you want expanded, then click
  138.     on the AmigaGuide close gadget.  The expanded module(s) will then
  139.     automatically be loaded into your text reader for examination.
  140.  
  141.  
  142.     Problems/Questions:
  143.     ------------------
  144.     Address comments or questions to:
  145.  
  146.              Robert Bromley                         Email:
  147.              1168 Timber Lane
  148.              Victoria,   B.C.          Bob_Bromley@amusers.victoria.bc.ca
  149.              CANADA
  150.  
  151.     Hope you find this useful.
  152.           __
  153.          /_/  __   /_
  154.      _  /_/  /_/  /_/  _
  155.